home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 51 / Amiga Format CD51 (2000-03-10)(Future Publishing)(GB)[!][issue 2000-04].iso / -in_the_mag- / pdselect / awnp / awnp-docs / arexx.doc < prev    next >
Text File  |  2000-02-16  |  1KB  |  50 lines
  1. Arexx event  stream
  2. -------------------
  3.  
  4. Arexx events are handled differently than other types of events, be careful.
  5.  
  6. The events are as follows.
  7.  
  8.  
  9. 'arexx FID textlength <newline> text'
  10.  
  11.     FID is the function ID number
  12.  
  13.     textlength is the length of the text after the newline character.
  14.  
  15.  
  16. If modify is turned on, after each event you MUST write a single line to the pipe in the following format.
  17.  
  18. 'rc=number result="result text"'
  19.  
  20. If rc > 0 result is ignored, if RC is omitted it defaults to 0.
  21.  
  22.  The pipe replies with 'ok' to your result line (unless quiet is set).
  23.  
  24. If modify is not turned on all arexx events are given a rc of 0 (success) and a null result.
  25.  
  26. Arexx object parameters.
  27. -------------------------
  28.  
  29. gadgettext="HOSTNAME|Function0|Function1|..."  (gt=)
  30.  
  31. The gadget text defines the arexx host name and the functions available. Hostname should be all capitals, function names should not contain spaces. The first function is FID 0, the second FID 1, ...
  32.  
  33. slot
  34.  
  35. This switch causes a slot number to appended to the host name. TESTHOST would become TESTHOST.1 or TESTHOST.2 ect.
  36.  
  37. Arexx definition Reply
  38. ----------------------
  39.  
  40.  When the ARexx object creation is successful the pipe replies with
  41.  
  42. 'ok HOSTNAME'
  43.  
  44. NOTE only one arexx host can be defined for each GUI window.
  45.  
  46. Additional info
  47. ---------------------
  48.  
  49. To have a arexx host with no GUI window, set the NoWindow switch in the window definition.  See the window docs for more information.
  50.